]> dgit.raspbian.org Git - gnome-shell.git/commitdiff
Fix documentation warnings
authorGiovanni Campagna <gcampagna@src.gnome.org>
Fri, 6 Apr 2012 14:34:52 +0000 (16:34 +0200)
committerGiovanni Campagna <gcampagna@src.gnome.org>
Mon, 9 Apr 2012 17:57:51 +0000 (19:57 +0200)
gobject-introspection now emits many more warnings for malformed
comments, and they fail the build.

https://bugzilla.gnome.org/show_bug.cgi?id=673656

22 files changed:
src/gvc/gvc-channel-map.c
src/gvc/gvc-mixer-card.c
src/gvc/gvc-mixer-control.c
src/gvc/gvc-mixer-event-role.c
src/gvc/gvc-mixer-sink-input.c
src/gvc/gvc-mixer-sink.c
src/gvc/gvc-mixer-source-output.c
src/gvc/gvc-mixer-source.c
src/gvc/gvc-mixer-stream.c
src/shell-app-system.c
src/shell-contact-system.c
src/shell-global.c
src/shell-keyring-prompt.c
src/shell-screenshot.c
src/shell-window-tracker.c
src/shell-wm.c
src/st/st-adjustment.h
src/st/st-texture-cache.c
src/st/st-theme.c
src/st/st-types.h
src/st/st-widget.c
src/st/st-widget.h

index 74ff40534203bacdabc2cc9b2a165997277cdbf3..7a01304f6aaab31a7d021670fc953548fea42123 100644 (file)
@@ -122,7 +122,6 @@ gvc_channel_map_get_mapping (const GvcChannelMap  *map)
 
 /**
  * gvc_channel_map_has_position: (skip)
- *
  * @map:
  * @position:
  *
index 168bc7989f26cd4268291f8b1b17d9a84de7806c..4ac4a24c738c3a9fb91dec917172f31ba33b86b3 100644 (file)
@@ -146,7 +146,6 @@ gvc_mixer_card_set_icon_name (GvcMixerCard *card,
 
 /**
  * gvc_mixer_card_get_profile: (skip)
- *
  * @card:
  *
  * Returns:
index aaa29c0ae61ec03dd3b5f64e684fb6c408ebc753..247d64b39aca961eb85181ac89eacb47d7e8113c 100644 (file)
@@ -113,7 +113,6 @@ gvc_mixer_control_get_pa_context (GvcMixerControl *control)
 
 /**
  * gvc_mixer_control_get_event_sink_input:
- *
  * @control:
  *
  * Returns: (transfer none):
@@ -231,7 +230,6 @@ gvc_mixer_control_set_default_source (GvcMixerControl *control,
 
 /**
  * gvc_mixer_control_get_default_sink:
- *
  * @control:
  *
  * Returns: (transfer none):
@@ -255,7 +253,6 @@ gvc_mixer_control_get_default_sink (GvcMixerControl *control)
 
 /**
  * gvc_mixer_control_get_default_source:
- *
  * @control:
  *
  * Returns: (transfer none):
@@ -287,7 +284,6 @@ gvc_mixer_control_lookup_id (GHashTable *hash_table,
 
 /**
  * gvc_mixer_control_lookup_stream_id:
- *
  * @control:
  * @id:
  *
@@ -304,7 +300,6 @@ gvc_mixer_control_lookup_stream_id (GvcMixerControl *control,
 
 /**
  * gvc_mixer_control_lookup_card_id:
- *
  * @control:
  * @id:
  *
@@ -361,7 +356,6 @@ gvc_card_collate (GvcMixerCard *a,
 
 /**
  * gvc_mixer_control_get_cards:
- *
  * @control:
  *
  * Returns: (transfer container) (element-type Gvc.MixerCard):
@@ -398,7 +392,6 @@ gvc_stream_collate (GvcMixerStream *a,
 
 /**
  * gvc_mixer_control_get_streams:
- *
  * @control:
  *
  * Returns: (transfer container) (element-type Gvc.MixerStream):
@@ -419,7 +412,6 @@ gvc_mixer_control_get_streams (GvcMixerControl *control)
 
 /**
  * gvc_mixer_control_get_sinks:
- *
  * @control:
  *
  * Returns: (transfer container) (element-type Gvc.MixerSink):
@@ -440,7 +432,6 @@ gvc_mixer_control_get_sinks (GvcMixerControl *control)
 
 /**
  * gvc_mixer_control_get_sources:
- *
  * @control:
  *
  * Returns: (transfer container) (element-type Gvc.MixerSource):
@@ -461,7 +452,6 @@ gvc_mixer_control_get_sources (GvcMixerControl *control)
 
 /**
  * gvc_mixer_control_get_sink_inputs:
- *
  * @control:
  *
  * Returns: (transfer container) (element-type Gvc.MixerSinkInput):
@@ -482,7 +472,6 @@ gvc_mixer_control_get_sink_inputs (GvcMixerControl *control)
 
 /**
  * gvc_mixer_control_get_source_outputs:
- *
  * @control:
  *
  * Returns: (transfer container) (element-type Gvc.MixerSourceOutput):
index 5a28767588964063e13721d7f3ea8ece952095c9..c5925a3a7a701d93e4bf0475b7f7f9760a9b98cf 100644 (file)
@@ -206,9 +206,8 @@ gvc_mixer_event_role_finalize (GObject *object)
 
 /**
  * gvc_mixer_event_role_new: (skip)
- *
  * @context:
- * @index:
+ * @device:
  * @channel_map:
  *
  * Returns:
index 03ba3b2f290cb2b3a1dc65d9a0ec7cc39bbd1a8d..91b21ddedf301d64e78a594bc089886de92f491b 100644 (file)
@@ -142,10 +142,9 @@ gvc_mixer_sink_input_finalize (GObject *object)
 
 /**
  * gvc_mixer_sink_input_new: (skip)
- *
  * @context:
  * @index:
- * @channel_map:
+ * @map:
  *
  * Returns:
  */
index a6f14935fb01cff1aeae42c05ac225d2f4348896..57c71c32928105ec1b4967430b4038d30f25a048 100644 (file)
@@ -175,10 +175,9 @@ gvc_mixer_sink_finalize (GObject *object)
 
 /**
  * gvc_mixer_sink_new: (skip)
- *
  * @context:
  * @index:
- * @channel_map:
+ * @map:
  *
  * Returns:
  */
index 536487b704c1048a6dbb24ecf2b8110c6e51c57e..dbafc6d3090e52321e8f8911f667056e8efa4ea7 100644 (file)
@@ -97,10 +97,9 @@ gvc_mixer_source_output_finalize (GObject *object)
 
 /**
  * gvc_mixer_source_output_new: (skip)
- *
  * @context:
  * @index:
- * @channel_map:
+ * @map:
  *
  * Returns:
  */
index ebb05a6a848e45d509297ae24817a67bb48ace41..321c09ad438dbc7bfb92e1c81243cef8b56a7a85 100644 (file)
@@ -175,10 +175,9 @@ gvc_mixer_source_finalize (GObject *object)
 
 /**
  * gvc_mixer_source_new: (skip)
- *
  * @context:
  * @index:
- * @channel_map:
+ * @map:
  *
  * Returns:
  */
index f35954ad54fffe201aec80f1e613129bfad022d7..627b3243a6e0d41e4c4f02196253850cada922a8 100644 (file)
@@ -130,7 +130,6 @@ gvc_mixer_stream_get_channel_map (GvcMixerStream *stream)
 
 /**
  * gvc_mixer_stream_get_volume:
- *
  * @stream:
  *
  * Returns: (type guint32) (transfer none):
@@ -154,7 +153,6 @@ gvc_mixer_stream_get_decibel (GvcMixerStream *stream)
 
 /**
  * gvc_mixer_stream_set_volume:
- *
  * @stream:
  * @volume: (type guint32):
  *
@@ -420,7 +418,6 @@ gvc_mixer_stream_set_icon_name (GvcMixerStream *stream,
 
 /**
  * gvc_mixer_stream_get_base_volume:
- *
  * @stream:
  *
  * Returns: (type guint32) (transfer none):
@@ -435,7 +432,6 @@ gvc_mixer_stream_get_base_volume (GvcMixerStream *stream)
 
 /**
  * gvc_mixer_stream_set_base_volume:
- *
  * @stream:
  * @base_volume: (type guint32):
  *
index a80b23398145bb38c816cbb3bc164ae8341c300a..2528e9f67f04078c43adbdbe988621866fa8dcc6 100644 (file)
@@ -470,7 +470,7 @@ shell_app_system_get_settings_tree (ShellAppSystem *self)
 
 /**
  * shell_app_system_lookup_setting:
- * @self:
+ * @system:
  * @id: desktop file id
  *
  * Returns: (transfer none): Application in gnomecc.menu, or %NULL if none
@@ -610,7 +610,7 @@ shell_app_system_lookup_heuristic_basename (ShellAppSystem *system,
 
 /**
  * shell_app_system_get_all:
- * @self:
+ * @system:
  *
  * Returns: (transfer container) (element-type ShellApp): All installed applications
  */
index 20e17a575e837c87d4e5fe20ea946b6fdc16c26c..8d5109fb00eaf215fe3123a801e0e4f69d8f1c93 100644 (file)
@@ -90,7 +90,7 @@ shell_contact_system_class_init (ShellContactSystemClass *klass)
   g_type_class_add_private (object_class, sizeof (ShellContactSystemPrivate));
 }
 
-/**
+/*
  * normalize_terms:
  * @terms: (element-type utf8): Input search terms
  *
index b7060695678ea7c763d8370c10b0eeda961082d8..c20c07c2c8a15587cf7e7cc81bd5bdd6ceea2914 100644 (file)
@@ -1102,7 +1102,7 @@ shell_global_end_modal (ShellGlobal *global,
 }
 
 /**
- * shell_global_create_pointer_barrier
+ * shell_global_create_pointer_barrier:
  * @global: a #ShellGlobal
  * @x1: left X coordinate
  * @y1: top Y coordinate
@@ -1133,7 +1133,7 @@ shell_global_create_pointer_barrier (ShellGlobal *global,
 }
 
 /**
- * shell_global_destroy_pointer_barrier
+ * shell_global_destroy_pointer_barrier:
  * @global: a #ShellGlobal
  * @barrier: a pointer barrier
  *
index e7a658844c5d8fef7a39ae3dd84583ed98dacae2..01eb409f8a440e0ec39383a2ed42a8946f038be0 100644 (file)
@@ -322,7 +322,7 @@ shell_keyring_prompt_class_init (ShellKeyringPromptClass *klass)
   g_object_class_override_property (gobject_class, PROP_CANCEL_LABEL, "cancel-label");
 
   /**
-   * ShellKeyringPrompt:password-visible
+   * ShellKeyringPrompt:password-visible:
    *
    * Whether the password entry is visible or not.
    */
@@ -331,7 +331,7 @@ shell_keyring_prompt_class_init (ShellKeyringPromptClass *klass)
                                    FALSE, G_PARAM_READABLE));
 
   /**
-    * ShellKeyringPrompt:confirm-visible
+    * ShellKeyringPrompt:confirm-visible:
     *
     * Whether the password confirm entry is visible or not.
     */
@@ -340,7 +340,7 @@ shell_keyring_prompt_class_init (ShellKeyringPromptClass *klass)
                                    FALSE, G_PARAM_READABLE));
 
   /**
-   * ShellKeyringPrompt:warning-visible
+   * ShellKeyringPrompt:warning-visible:
    *
    * Whether the warning label is visible or not.
    */
@@ -349,7 +349,7 @@ shell_keyring_prompt_class_init (ShellKeyringPromptClass *klass)
                                    FALSE, G_PARAM_READABLE));
 
   /**
-   * ShellKeyringPrompt:choice-visible
+   * ShellKeyringPrompt:choice-visible:
    *
    * Whether the choice check box is visible or not.
    */
@@ -358,7 +358,7 @@ shell_keyring_prompt_class_init (ShellKeyringPromptClass *klass)
                                    FALSE, G_PARAM_READABLE));
 
   /**
-   * ShellKeyringPrompt:password-actor
+   * ShellKeyringPrompt:password-actor:
    *
    * Text field for password
    */
@@ -367,7 +367,7 @@ shell_keyring_prompt_class_init (ShellKeyringPromptClass *klass)
                                    CLUTTER_TYPE_TEXT, G_PARAM_READWRITE));
 
   /**
-   * ShellKeyringPrompt:confirm-actor
+   * ShellKeyringPrompt:confirm-actor:
    *
    * Text field for confirmation password
    */
index 33b981e8e2ad4cf2372dd029988b400397833711..2f583407e5c148ef7fcf91bb83b5d586f829e116 100644 (file)
@@ -322,7 +322,6 @@ shell_screenshot_screenshot_area (ShellScreenshot *screenshot,
  * @screenshot: the #ShellScreenshot
  * @include_frame: Whether to include the frame or not
  * @include_cursor: Whether to include the cursor or not
- *
  * @filename: The filename for the screenshot
  * @callback: (scope async): function to call returning success or failure
  * of the async grabbing
index 97d7aed4ff50813a522a59ddf917b56282e87681..cc16fe08394b75e304856b080b9d11d67b405c74 100644 (file)
@@ -742,7 +742,7 @@ on_focus_window_changed (MetaDisplay        *display,
 
 /**
  * shell_window_tracker_get_startup_sequences:
- * @self:
+ * @tracker:
  *
  * Returns: (transfer none) (element-type ShellStartupSequence): Currently active startup sequences
  */
index 4a2337c76c8730c1009f0a14f7439b781ecf40d4..835c970cd84e632ebe115de89225bb6710c4500f 100644 (file)
@@ -141,7 +141,7 @@ shell_wm_completed_switch_workspace (ShellWM *wm)
 }
 
 /**
- * shell_wm_completed_minimize
+ * shell_wm_completed_minimize:
  * @wm: the ShellWM
  * @actor: the MetaWindowActor actor
  *
@@ -155,7 +155,7 @@ shell_wm_completed_minimize (ShellWM         *wm,
 }
 
 /**
- * shell_wm_completed_maximize
+ * shell_wm_completed_maximize:
  * @wm: the ShellWM
  * @actor: the MetaWindowActor actor
  *
@@ -169,7 +169,7 @@ shell_wm_completed_maximize (ShellWM         *wm,
 }
 
 /**
- * shell_wm_completed_unmaximize
+ * shell_wm_completed_unmaximize:
  * @wm: the ShellWM
  * @actor: the MetaWindowActor actor
  *
@@ -183,7 +183,7 @@ shell_wm_completed_unmaximize (ShellWM         *wm,
 }
 
 /**
- * shell_wm_completed_map
+ * shell_wm_completed_map:
  * @wm: the ShellWM
  * @actor: the MetaWindowActor actor
  *
@@ -197,7 +197,7 @@ shell_wm_completed_map (ShellWM         *wm,
 }
 
 /**
- * shell_wm_completed_destroy
+ * shell_wm_completed_destroy:
  * @wm: the ShellWM
  * @actor: the MetaWindowActor actor
  *
index 95c1593790fc277078b3b9ea1c07b4215d968db1..7660a08ecad40e52d2e0311a529a47e127ce1408 100644 (file)
@@ -57,7 +57,7 @@ struct _StAdjustment
 };
 
 /**
- * StAdjustmentClass
+ * StAdjustmentClass:
  * @changed: Class handler for the ::changed signal.
  *
  * Base class for #StAdjustment.
index 30c9a0bc8926a8ca8e54ad7aa94b3c485c9c3040..45f393077d5820abf91bcc352cc80ec7b5ce274f 100644 (file)
@@ -328,7 +328,6 @@ texture_load_data_destroy (gpointer p)
 
 /**
  * on_image_size_prepared:
- *
  * @pixbuf_loader: #GdkPixbufLoader loading the image
  * @width: the original width of the image
  * @height: the original height of the image
@@ -1241,7 +1240,6 @@ st_texture_cache_load_icon_name (StTextureCache    *cache,
 
 /**
  * st_texture_cache_load_uri_async:
- *
  * @cache: The texture cache instance
  * @uri: uri of the image file from which to create a pixbuf
  * @available_width: available width for the image, can be -1 if not limited
index 551fb2c1fed3b790d309a2d20c9feaf4b416ef00..adb29db993fbf435086a8ab55df077b529d0b9e3 100644 (file)
@@ -518,7 +518,7 @@ class_add_sel_matches_style (CRAdditionalSel *a_add_sel,
   return string_in_list (a_add_sel->content.class_name->stryng, element_class);
 }
 
-/**
+/*
  *@return TRUE if the additional attribute selector matches
  *the current style node given in argument, FALSE otherwise.
  *@param a_add_sel the additional attribute selector to consider.
@@ -616,7 +616,7 @@ element_name_matches_type (const char *element_name,
     }
 }
 
-/**
+/*
  *Evaluate a selector (a simple selectors list) and says
  *if it matches the style node given in parameter.
  *The algorithm used here is the following:
index 2bbe141a1c9d4f7be1bda81977e412f703a6e07c..13bf3f8871c5a213d135f4769950dd323c45c278 100644 (file)
  * You should have received a copy of the GNU Lesser General Public License
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
-
-/**
- * SECTION:st-types
- * @short_description: type definitions used throughout St
- *
- * Common types for StWidgets.
- */
-
+#ifndef __ST_TYPES_H__
+#define __ST_TYPES_H__
 
 #if !defined(ST_H_INSIDE) && !defined(ST_COMPILATION)
 #error "Only <st/st.h> can be included directly.h"
 #endif
 
-#ifndef __ST_TYPES_H__
-#define __ST_TYPES_H__
-
 #include <glib-object.h>
 #include <clutter/clutter.h>
 #include <gtk/gtk.h>
 
 G_BEGIN_DECLS
 
+/**
+ * SECTION:st-types
+ * @short_description: type definitions used throughout St
+ *
+ * Common types for StWidgets.
+ */
+
 typedef enum {
   ST_ALIGN_START,
   ST_ALIGN_MIDDLE,
index 27db9e19545e8cafeda6e168def82191b6f58573..88d05c19b7b37922572c5bd4c83a865f503d1466 100644 (file)
@@ -855,7 +855,7 @@ st_widget_class_init (StWidgetClass *klass)
                                                         ST_PARAM_READWRITE));
 
   /**
-   * StWidget:theme
+   * StWidget:theme:
    *
    * A theme set on this actor overriding the global theming for this actor
    * and its descendants
@@ -2145,7 +2145,6 @@ st_describe_actor (ClutterActor *actor)
 
 /**
  * st_set_slow_down_factor:
- *
  * @factor: new slow-down factor
  *
  * Set a global factor applied to all animation durations
index 17a5c60188bba542cdb103f65460db636fdd7c78..eb9e4cec188ef22a64a767408e842a488ac6851b 100644 (file)
@@ -78,7 +78,7 @@ struct _StWidgetClass
   /* vfuncs */
 
   /**
-   * StWidgetClass::navigate_focus
+   * StWidgetClass::navigate_focus:
    * @self: the "top level" container
    * @from: (allow-none): the actor that the focus is coming from
    * @direction: the direction focus is moving in